<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Phing API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/jquery-ui.css" type="text/css"></link><link rel="stylesheet" href="css/docblox/jquery-ui-1.8.16.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.tools.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
            $(document).ready(function() {
                $(".filetree").treeview({
                    collapsed: true,
                    persist: "cookie"
                });

                $("#accordion").accordion({
                    collapsible: true,
                    autoHeight:  false,
                    fillSpace:   true
                });

                $(".tabs").tabs();
            });
        </script></head><body><div xmlns="" id="content">
<script xmlns:dbx="http://docblox-project.org/xsl/functions">

      function filterElements()
      {
        inherited = !$('#show-inherited').hasClass('deselected');
        public    = !$('#show-public').hasClass('deselected');
        protected = !$('#show-protected').hasClass('deselected');
        private   = !$('#show-private').hasClass('deselected');

        $('div.public').each(function(index, val) {
            $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.protected').each(function(index, val) {
            $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.private').each(function(index, val) {
            $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
        });
      }

      $(document).ready(function() {
        $('a.gripper').click(function() {
            $(this).nextAll('div.code-tabs').slideToggle();
            $(this).children('img').toggle();
            return false;
        });

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
            $(this).parent().nextAll('div.code-tabs').slideToggle();
            $(this).parent().prevAll('a.gripper').children('img').toggle();
            return false;
        });

        $('div.code-tabs').hide();
        $('a.gripper').show();
        $('div.code-tabs:empty').prevAll('a.gripper').html('');

        $('#show-public, #show-protected, #show-private, #show-inherited')
            .css('cursor', 'pointer')
            .click(function(){
                $(this).toggleClass('deselected');
                if ($(this).hasClass('deselected')) {
                  $(this).fadeTo('fast', '0.4');
                } else {
                  $(this).fadeTo('fast', '1.0');
                }
                filterElements();
                return false;
            });
        $('#show-protected, #show-private').click();

        // add the sliding behaviour to the file navigation and show it
        // it is initially hidden for non-JS users.
        $("#file-nav-box").show().hover(function() {
            $("#file-nav-container").slideDown(400);
        }, function() {
            $("#file-nav-container").slideUp(400);
        });
      });

      
    </script><h1 xmlns:dbx="http://docblox-project.org/xsl/functions" class="file">tasks/ext/phpdoc/PhingPhpDocumentorSetup.php</h1>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" id="file-nav-box">
<div id="file-nav-options">
              Show:
              <img src="images/icons/visibility_public.png" id="show-public"><img src="images/icons/visibility_protected.png" id="show-protected"><img src="images/icons/visibility_private.png" id="show-private"><span class="attribute" id="show-inherited">inherited</span>
</div>
<div id="file-nav-container">
<ul id="file-nav"><li>
<a href="#classes"><img src="images/icons/class.png" height="14">
                          Classes
                      </a><ul><li><a href="#%5CPhingPhpDocumentorSetup">\PhingPhpDocumentorSetup</a></li></ul>
</li></ul>
<div style="clear: left;"></div>
</div>
<div id="file-nav-tab">
              Table of Contents
          </div>
</div>
<a xmlns:dbx="http://docblox-project.org/xsl/functions" name="top" class="anchor"></a><div id="file-description">
<p xmlns:dbx="http://docblox-project.org/xsl/functions" class="short-description">$Id: PhingPhpDocumentorSetup.php 1108 2011-05-23 15:01:31Z mrook $</p>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="long-description"><p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>

<p>This software consists of voluntary contributions made by many individuals
and is licensed under the LGPL. For more information please see
<a href="http://phing.info">http://phing.info</a>.</p></div>
</div>
<a name="classes" class="anchor"></a><a xmlns:dbx="http://docblox-project.org/xsl/functions" id="\PhingPhpDocumentorSetup" class="anchor"></a><h2 xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">\PhingPhpDocumentorSetup<div class="to-top"><a href="#top">jump to top</a></div>
</h2>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">
<small class="package"><b>Package: </b>phing\tasks\ext\phpdoc</small><p class="short-description">Phing subclass of the phpDocumentor_setup class provided with PhpDocumentor to work around limitations in PhpDocumentor API.</p>
<div class="long-description"><p>This class is necessary because phpDocumentor_setup does not expose a complete API for setting configuration options.  Because
this class must directly modify some "private" GLOBAL(!) configuration variables, it is liable to break if the PhpDocumentor
internal implementation changes.  Obviously this is far from ideal, but there's also no solution given the inflexibility of the
PhpDocumentor design.</p></div>
<dl class="class-info">
<dt>Parent(s)</dt>
<dd>\phpDocumentor_setup</dd>
<dt>Author</dt>
<dd>Hans Lellelid <hans@xmpl.org>@author hans
         
    </dd>
<dt>Version</dt>
<dd>$Id: PhingPhpDocumentorSetup.php 1108 2011-05-23 15:01:31Z mrook $
         
    </dd>
</dl>
<h3>Methods</h3>
<div>
<a id="\PhingPhpDocumentorSetup::__construct()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">__construct</span><span class="nb-faded-text">(
           $configdir
              =
              null, object $task
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Constructs a new PhingPhpDocumentorSetup.</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$configdir</th>
<td></td>
<td><em></em></td>
</tr>
<tr>
<th>$task</th>
<td>object</td>
<td><em><p>The task we're working with, so we can pass it on to the ErrorTracker</p>
</em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setCustomtags()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setCustomtags</span><span class="nb-faded-text">(
          string $sCustomtags
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">custom tags, will be recognized and put in tags[] instead of
unknowntags[]</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because the API exposed for this method in
PhpDocumentor doesn't work correctly.</p>

<p>Note that because we are setting a "private" GLOBAL(!!) config var with
this value, this is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$sCustomtags</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setDefaultCategoryName()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setDefaultCategoryName</span><span class="nb-faded-text">(
          string $name
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Sets the default category name.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because there is no API exposed for this in PhpDocumentor.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$name</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setDefaultPackageName()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setDefaultPackageName</span><span class="nb-faded-text">(
          string $name
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Sets the default package name.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because there is no API exposed for this in PhpDocumentor.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$name</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setExamplesDir()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setExamplesDir</span><span class="nb-faded-text">(
          string $dir
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Set fullpath to directory to look in for examples.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because there is no API exposed for this in PhpDocumentor.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$dir</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setGenerateSourcecode()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setGenerateSourcecode</span><span class="nb-faded-text">(
          bool $b
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Set whether to generate sourcecode for each file parsed.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because there is no API exposed for this in PhpDocumentor.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$b</th>
<td>bool</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setIgnore()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setIgnore</span><span class="nb-faded-text">(
          string $sIgnore
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Files to ignore</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$sIgnore</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setIgnoreTags()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setIgnoreTags</span><span class="nb-faded-text">(
          string $tags
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Set comma-separated list of tags to ignore.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because there is no API exposed for this in PhpDocumentor.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$tags</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setPear()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setPear</span><span class="nb-faded-text">(
          bool $b
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Set whether to parse dirs as PEAR repos.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because there is no API exposed for this in PhpDocumentor.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$b</th>
<td>bool</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setQuietMode()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setQuietMode</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Enables quiet mode.</p></div>
<div class="code-tabs"><div class="long-description"><p>This method exists as a hack because the API exposed for this method in PhpDocumentor
doesn't work correctly.</p>

<p>Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div></div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setRicFiles()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setRicFiles</span><span class="nb-faded-text">(
          array $files
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Set an array of README/INSTALL/CHANGELOG file paths.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This method exists as a hack because there is no API exposed for this in PhpDocumentor.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this
is subject to break if PhpDocumentor internals changes.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$files</th>
<td>array</td>
<td><em><p>Absolute paths to files.</p></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhingPhpDocumentorSetup::setUndocumentedelements()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setUndocumentedelements</span><span class="nb-faded-text">(
          bool $bEnable
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Control whether or not warnings will be shown for undocumented elements.</p></div>
<div class="code-tabs">
<div class="long-description"><p>Useful for identifying classes and methods that haven't yet been
documented.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$bEnable</th>
<td>bool</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.17.1</a>.
    </small></body></html>
